it-concat
![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)
Concat all buffers/strings yielded from an async iterable into a single BufferList
/string
.
Install
npm install it-concat
Usage
Concat buffers to a single BufferList
:
const concat = require('it-concat')
const fs = require('fs')
fs.writeFileSync('./test.txt', 'Hello World!')
const chunks = await concat(fs.createReadStream('./test.txt'))
console.log(chunks)
console.log(chunks.toString())
Concat buffers to a single string:
const concat = require('it-concat')
const fs = require('fs')
fs.writeFileSync('./test.txt', 'Hello World!')
const chunks = await concat(fs.createReadStream('./test.txt'), { type: 'string' })
console.log(chunks)
Concat strings to a single string:
const concat = require('it-concat')
const fs = require('fs')
fs.writeFileSync('./test.txt', 'Hello World!')
const chunks = await concat(fs.createReadStream('./test.txt', { encoding: 'utf8' }))
console.log(chunks)
API
const concat = require('it-concat')
concat(source, options?): Promise
Concat all buffers or strings yielded from the async iterable source
into a single BufferList
or string
.
source
(AsyncIterable<Buffer | BufferList | string>
) - the source iterable to concat fromoptions
(Object
) - optional optionsoptions.type
(string
) - return type of the function, pass 'string'
to recieve a string or 'buffer'
for a BufferList
.
Returns a Promise
that resolves to a BufferList
or string
.
If options.type
is not passed the type of the objects yielded from the source
is detected and a BufferList
or string
is returned appropriately. If the source
does not yield anything an empty BufferList
is returned. If the source is expected to return strings (but may not yield anything), pass options.type: 'string'
to ensure an empty string is returned instead of an empty BufferList
.
Related
stream-to-it
Convert Node.js streams to streaming iterablesit-pipe
Utility to "pipe" async iterables together
List of awesome modules for working with async iterables.
Contribute
Feel free to dive in! Open an issue or submit PRs.
License
MIT © Alan Shaw